HPD Retrieval API icon

HPD Retrieval API

1.0.x
(0 reviews)

Response Payload

Keys

Response payload will contain the following: - COMMENT: PROVIDE A SAMPLE REQUEST PAYLOAD TO GET THE CONTINUATION RECORDS. - MATT TO PROVIDE GET URL WITH PARAMETER AND SAMPLE REQUEST PAYLOAD

  • continuationData - this will provide a token if there are more results, and you would like to get the next page
  • hasMoreResults - true if there is more results to receive in the next page
  • fhirBundles - if queryResultType is FhirBundleAttribute, this will contain an array of fhir bundles
  • jsonResults - if queryResultType is JsonAttribute, this will contain an array of JSONS as the entity is held in cosmosdb
  • fhirResults - if queryResultType is FhirAttribute, this will contain an array of Fhir Object

Response Payload Structure

{
"continuationData": null,
"hasMoreResults": false,
"fhirBundles": [],
"jsonResults": [],
"fhirResults": []
}

Reviews